Skip to content

Add a preliminary CHANGELOG.md.#289

Merged
AdrienHerubel merged 2 commits intoAcademySoftwareFoundation:dev_1.2from
portsmouth:add_changelog
Dec 9, 2025
Merged

Add a preliminary CHANGELOG.md.#289
AdrienHerubel merged 2 commits intoAcademySoftwareFoundation:dev_1.2from
portsmouth:add_changelog

Conversation

@portsmouth
Copy link
Copy Markdown
Contributor

@portsmouth portsmouth commented Dec 9, 2025

This adds a changelog, with a proposed format for the description. (It includes only the PRs merged thus-far!)

Probably this needs to be improved to give more details of the specific changes that an implementation would need to make, relative to the previous version. It functions as a summary mostly though, from which we can construct the more detailed logic for parameter changes.

Note that we have an auto-generated change list at https://github.com/AcademySoftwareFoundation/OpenPBR/releases as well (which could be enhanced a bit as well, e.g. using labels more consistently), so this is more like a overall summary of all changes in one file, with more detailed human-curated descriptions and explanations.


Change Log

This file gives a high level overview of the changes introduced between versions, relative to version 1.0.

[1.2] - Unreleased

[1.1] - Jun 28, 2024

  • Change thin film IOR default #211: This won't make much difference to the look in implementations that ignore the adjacent IORs of the film, but for those that take it into account, this will make the film visible rather than invisible by default (since specular_ior is 1.5 by default, and coat_ior 1.6).

  • Enable Zeltner sheen #217: This change enables Zeltner sheen in the reference implementation of OpenPBR, leveraging the new functionality in MaterialX.

[1.0] - Jun 4, 2024

  • First release.

Updated the CHANGELOG to reflect recent enhancements and bug fixes, including changes to specular behavior and new parameters.

Signed-off-by: Adrien Herubel <AdrienHerubel@users.noreply.github.com>
@AdrienHerubel AdrienHerubel merged commit e3194ef into AcademySoftwareFoundation:dev_1.2 Dec 9, 2025
1 check passed
@virtualzavie
Copy link
Copy Markdown
Contributor

Are we planning to standardise and/or automate this process in the future, in a fashion similar to Semantic Versionning tools? Or do we consider the number of changes will likely remain small enough that this is better done manually?

@portsmouth
Copy link
Copy Markdown
Contributor Author

portsmouth commented Jan 19, 2026

Note that there is an auto-generated change-log here in the "releases" page:

https://github.com/AcademySoftwareFoundation/OpenPBR/releases

But it is just a list of the PRs by name. The separate curated one has more discussion and detail of what was done, so seems useful to maintain as well. The idea was that this could function as a reference for people doing updates to their implementations or writing upgrade logic, so as much detail as possible would be helpful. (Including formulas/code perhaps).

Possibly there is some way to have the auto-generated one include additional manually written discussion, which would be another option (but still require curation obviously).

Though note that the current version ended up a bit broken since the GitHub markdown syntax in it doesn't seem to render properly, so we need to fix that.

AdrienHerubel added a commit to AdrienHerubel/OpenPBR that referenced this pull request Apr 17, 2026
* Add a preliminary CHANGELOG.md.

Updated the CHANGELOG to reflect recent enhancements and bug fixes, including changes to specular behavior and new parameters.

Signed-off-by: Adrien Herubel <AdrienHerubel@users.noreply.github.com>

---------

Signed-off-by: Adrien Herubel <AdrienHerubel@users.noreply.github.com>
Co-authored-by: Adrien Herubel <AdrienHerubel@users.noreply.github.com>
jstone-lucasfilm pushed a commit that referenced this pull request Apr 17, 2026
This PR increases the version to 1.1.1 and backports any missing change in the branch, it also adds a complete changelog for 1.1 and 1.1.1.

Backported PRs : 
- #235
- #230 
- #218 
- #289 
- #236 
- #262
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants